Skip to content

docs: clarify that -om is required to activate output modules (#1285) - #3137

Closed
anupddas wants to merge 1 commit into
blacklanternsecurity:devfrom
anupddas:fix/output-module-docs-issue-1285
Closed

docs: clarify that -om is required to activate output modules (#1285)#3137
anupddas wants to merge 1 commit into
blacklanternsecurity:devfrom
anupddas:fix/output-module-docs-issue-1285

Conversation

@anupddas

Copy link
Copy Markdown

Fixes #1285

Problem

Users configuring Discord/Slack/Teams output modules by setting webhook_url in bbot.yml would get no output and no error — because -om was never passed. The docs showed config-only examples without making the -om requirement clear.

Changes

  • Adds a warning admonition directly under the Output Modules heading with a example and the preset pattern as the permanent solution
  • Rewrites the Discord/Slack/Teams section to lead with explicit -om one-liners for all three services
  • Adds output_modules: to all preset YAML snippets in the section so every copy-paste example works correctly on its own

…anternsecurity#1285)

Users were setting webhook_url in bbot.yml for Discord/Slack/Teams and
getting no output with no error, because -om was never passed.

- Adds a warning admonition at the top of Output Modules with a clear example
- Rewrites the Discord/Slack/Teams section to lead with -om command-line examples for all three services
- Adds output_modules: to all preset YAML snippets so every example is self-contained and correct
@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@anupddas

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

@anupddas

Copy link
Copy Markdown
Author

recheck

bls-cla-bot Bot added a commit to blacklanternsecurity/CLA that referenced this pull request May 29, 2026
@anupddas

Copy link
Copy Markdown
Author

recheck

@liquidsec
liquidsec changed the base branch from stable to dev June 1, 2026 11:46
@liquidsec

Copy link
Copy Markdown
Collaborator

Hi, while you are correct that setting it with -om makes everything work, you can actually set it in the preset. You'd just use:

output_modules: [discord] (for example) in the preset

There are some things that to change about this behavior, though, which will be addressed before 3.0 is released. For example, currently, if you set output_modules: [webhook] - you'd still get the default with it ['csv', 'discord', 'json', 'python', 'txt']
But if you set output_modules: [discord,json]
you'd get literally that.

This is confusing and needs to change.

@liquidsec

Copy link
Copy Markdown
Collaborator

relevant: #3146

@liquidsec

Copy link
Copy Markdown
Collaborator

closing in favor of #3147

@liquidsec liquidsec closed this Jun 6, 2026
@anupddas
anupddas deleted the fix/output-module-docs-issue-1285 branch June 7, 2026 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Better documentation for output modules

2 participants